/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.pinot.spi.metrics;

import java.util.concurrent.TimeUnit;


/**
 * A timer metric which aggregates timing durations and provides duration statistics, plus
 * throughput statistics via {@link PinotMeter}.
 */
public interface PinotTimer extends PinotMetered {

  /**
   * Adds a recorded duration. It's basically the same as using time() and then stop().
   * Hereby we can update the time duration by calling just one method.
   * This is used to log the time span of each of the phase during query execution in Pinot.
   *
   * @param duration the length of the duration
   * @param unit     the scale unit of {@code duration}
   */
  void update(long duration, TimeUnit unit);

  /**
   * Returns the actual object of timer.
   */
  Object getTimer();
}
